

    \filetitle{shockplot}{Short-cut for running and plotting plain shock simulation}{model/shockplot}

	\paragraph{Syntax}

\begin{verbatim}
[S,FF,AA] = shockplot(M,ShockName,SimRange,PlotList,...)
\end{verbatim}

\paragraph{Input arguments}

\begin{itemize}
\item
  \texttt{M} {[} model {]} - Model object that will be simulated.
\item
  \texttt{ShkName} {[} char {]} - Name of the shock that will be
  simulated.
\item
  \texttt{Range} {[} numeric \textbar{} char {]} - Date range on which
  the shock will be simulated.
\item
  \texttt{PlotList} {[} cellstr {]} - List of variables that will be
  reported; you can use the syntax of
  \href{dbase/dbplot}{\texttt{dbase/dbplot}}.
\end{itemize}

\paragraph{Output arguments}

\begin{itemize}
\item
  \texttt{S} {[} struct {]} - Database with simulation results.
\item
  \texttt{FF} {[} numeric {]} - Handles of figure windows created.
\item
  \texttt{AA} {[} numeric {]} - Handles of axes objects created.
\end{itemize}

\paragraph{Options affecting the
simulation}

\begin{itemize}
\item
  \texttt{\textquotesingle{}deviation=\textquotesingle{}} {[}
  \emph{\texttt{true}} \textbar{} \texttt{false} {]} - See the option
  \texttt{\textquotesingle{}deviation=\textquotesingle{}} in
  \href{model/simulate}{\texttt{model/simulate}}.
\item
  \texttt{\textquotesingle{}dtrends=\textquotesingle{}} {[}
  \emph{\texttt{@auto}} \textbar{} \texttt{true} \textbar{}
  \texttt{false} {]} - See the option
  \texttt{\textquotesingle{}dtrends=\textquotesingle{}} option in
  \href{model/simulate}{\texttt{model/simulate}}.
\item
  \texttt{\textquotesingle{}shockSize=\textquotesingle{}} {[}
  \emph{\texttt{\textquotesingle{}std\textquotesingle{}}} \textbar{}
  numeric {]} - Size of the shock that will be simulated;
  \texttt{\textquotesingle{}std\textquotesingle{}} means that one std
  dev of the shock will be simulated.
\end{itemize}

\paragraph{Options affecting the
graphs}

See help on \href{dbase/dbplot}{\texttt{dbase/dbplot}} for other options
available.

\paragraph{Description}

The simulated shock always occurs at time \texttt{t=1}. Starting the
simulation range, \texttt{SimRange}, before \texttt{t=1} allows you to
simulate anticipated shocks.

The graphs automatically include one pre-sample period, i.e.~one period
prior to the start of the simulation.

\paragraph{Example}


